home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / DtWsmGetWorkspaceInfo.z / DtWsmGetWorkspaceInfo
Encoding:
Text File  |  2003-11-18  |  8.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnUUUUffffNNNNooooIIII((((XXXX3333))))SSSSyyyysssstttteeeemmmm VVVV ((((1111    AAAAuuuugggguuuussssttttDDDD1111tttt9999WWWW9999ssss5555mmmm))))GGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       DtWsmGetWorkspaceInfo    - get detailed workspace information
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       ####iiiinnnncccclllluuuuddddeeee <<<<DDDDtttt////WWWWssssmmmm....hhhh>>>>
  13.  
  14.       SSSSttttaaaattttuuuussss DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo((((DDDDiiiissssppppllllaaaayyyy ****_d_i_s_p_l_a_y,,,,
  15.                        WWWWiiiinnnnddddoooowwww _r_o_o_t,,,,
  16.                        AAAAttttoooommmm _a_W_o_r_k_s_p_a_c_e,,,,
  17.                        DDDDttttWWWWssssmmmmWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo ********_p_p_W_s_I_n_f_o))));;;;
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.       The DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo() function works with the CDE
  21.       workspace manager, ddddttttwwwwmmmm(1), and returns detailed information
  22.       on a specific    workspace.
  23.  
  24.       The _d_i_s_p_l_a_y argument is the X    display.
  25.  
  26.       The _r_o_o_t argument is the root    window of the screen of
  27.       interest.
  28.  
  29.       The _a_W_o_r_k_s_p_a_c_e argument is the workspace name    (converted to
  30.       an X atom).
  31.  
  32.       The *_p_p_W_s_I_n_f_o    argument is the    address    of a variable to
  33.       receive the returned pointer to the workspace    information
  34.       data.
  35.  
  36.       The DDDDttttWWWWssssmmmmWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo structure contains at least the
  37.       following members:
  38.       AAAAttttoooommmm          _w_o_r_k_s_p_a_c_e           The workspace name (converted to
  39.                            an X atom).
  40.       uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg      _b_g               The pixel ID used for the
  41.                            background color    of the
  42.                            backdrop.
  43.       uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg      _f_g               The pixel ID used for the
  44.                            foreground color    of the
  45.                            backdrop.
  46.       AAAAttttoooommmm          _b_a_c_k_d_r_o_p_N_a_m_e           The backdrop file name
  47.                            (converted to an    X atom).  The
  48.                            file must be in either X    Bitmap
  49.                            file format (with extension ....bbbbmmmm)
  50.                            or X Pixmap file    format (with
  51.                            extension ....ppppmmmm).    The workspace
  52.                            management services look    for the
  53.                            file along the same path    used
  54.                            for searching icons.  The
  55.                            directory ////uuuussssrrrr////ddddtttt////bbbbaaaacccckkkkddddrrrrooooppppssss is
  56.                            the default directory if    the
  57.                            file cannot be found along the
  58.                            icon search path.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnUUUUffffNNNNooooIIII((((XXXX3333))))SSSSyyyysssstttteeeemmmm VVVV ((((1111    AAAAuuuugggguuuussssttttDDDD1111tttt9999WWWW9999ssss5555mmmm))))GGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo((((3333))))
  71.  
  72.  
  73.  
  74.      iiiinnnntttt         _c_o_l_o_r_S_e_t_I_d          The colorset number used for
  75.                       this workspace, which    affects
  76.                       the backdrop color and the
  77.                       button color for this    workspace
  78.                       on the front panel.
  79.      cccchhhhaaaarrrr         *_p_c_h_T_i_t_l_e          The title displayed in the
  80.                       button for this workspace on the
  81.                       front    panel.    This string is
  82.                       interpreted in the locale in
  83.                       which    the CDE    workspace manager,
  84.                       ddddttttwwwwmmmm(1), is running.    The title
  85.                       is different from the    workspace
  86.                       name.     The workspace name, when
  87.                       converted from an X atom, is
  88.                       used as the identifier for a
  89.                       workspace in the workspace
  90.                       manager function calls.  The CDE
  91.                       workspace manager, ddddttttwwwwmmmm(1).
  92.                       also uses the    workspace name as
  93.                       a resource name; thus, the
  94.                       characters used in a workspace
  95.                       name are restricted to the
  96.                       characters in    the X Portable
  97.                       Character Set.  The workspace
  98.                       name for a workspace created
  99.                       from the front panel is
  100.                       generated automatically by the
  101.                       CDE workspace    manager, ddddttttwwwwmmmm(1).
  102.      WWWWiiiinnnnddddoooowwww         *_b_a_c_k_d_r_o_p_W_i_n_d_o_w_s      A pointer to an array    of windows
  103.                       that make up the backdrop.
  104.      iiiinnnntttt         _n_u_m_B_a_c_k_d_r_o_p_W_i_n_d_o_w_s      The number of    elements in the
  105.                       _b_a_c_k_d_r_o_p_W_i_n_d_o_w_s array.
  106.  
  107.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  108.       Upon successful completion, the DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo()
  109.       function returns Success and the workspace manager returns
  110.       in *_p_p_W_s_I_n_f_o a pointer to a DDDDttttWWWWssssmmmmIIIInnnnffffoooo    structure that
  111.       contains information about the workspace _a_W_o_r_k_s_p_a_c_e;
  112.       otherwise, it    returns    a value    not equal to Success.
  113.  
  114.      AAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNN UUUUSSSSAAAAGGGGEEEE
  115.       If the DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo() function is not successful,
  116.       failure may be due to    a memory allocation error or failure
  117.       to find the correct workspace    information (that is, the CDE
  118.       workspace manager, ddddttttwwwwmmmm(1), is not running).    The
  119.       application must use the DDDDttttWWWWssssmmmmFFFFrrrreeeeeeeeWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo(3) function
  120.       to free the data returned in *_p_p_W_s_I_n_f_o.  The
  121.       *_b_a_c_k_d_r_o_p_W_i_n_d_o_w_s pointer may be useful for applications that
  122.       are interested in some events    on the root window.  Since the
  123.       backdrop covers the root window, the backdrop    catches    the
  124.       button events    before they reach the root.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnUUUUffffNNNNooooIIII((((XXXX3333))))SSSSyyyysssstttteeeemmmm VVVV ((((1111    AAAAuuuugggguuuussssttttDDDD1111tttt9999WWWW9999ssss5555mmmm))))GGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo((((3333))))
  137.  
  138.  
  139.  
  140.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.       DDDDttttWWWWssssmmmm(5), ddddttttwwwwmmmm(1), DDDDttttWWWWssssmmmmGGGGeeeettttWWWWoooorrrrkkkkssssppppaaaacccceeeeLLLLiiiisssstttt(3),
  142.       DDDDttttWWWWssssmmmmFFFFrrrreeeeeeeeWWWWoooorrrrkkkkssssppppaaaacccceeeeIIIInnnnffffoooo(3).
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 11/11/03)
  196.  
  197.  
  198.  
  199.